ICAOffers::Remove

Microsoft DirectX 8.1 (C++)

ICAOffers::Remove

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The Remove method removes an offer from the collection.

Syntax

HRESULT Remove(
  VARIANT  Index
);

Parameters

Index

[in] VARIANT that specifies the offer to remove. See Remarks for more information.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_FALSE	The item was not found.
S_OK	Success.
E_FAIL	Caller is not authorized to remove this offer.
E_INVALIDARG	Index out of range.

Remarks

The Index parameter supports the following VARIANT types:

VT_I4: A zero-based index into the collection. The valid range is from 0 to ICAOffers::get_Count() - 1.
VT_UNKNOWN or VT_DISPATCH: Pointer to the IUnknown or IDispatch interface of the offer.

Before removing the offer, this method calls the ICAPolicy::get_OkToRemoveOffer method on the owning policy. If the policy returns FALSE, the Remove method returns E_FAIL.

See Also